Kanzi  3.9.8
Kanzi Engine Java API
FontFamily Class Reference
Inheritance diagram for FontFamily:
[legend]

Public Member Functions

void addFontFile (Font font, FontWeight weight, FontStyle style)
 Adds the passed font for a font family. More...
 
void addFontFile (Font font)
 Adds the passed font for a font family. More...
 
Font getFontFile (FontWeight weight, FontStyle style)
 Returns the best matching font file for the passed arguments weight and style that is held by font family. More...
 
Font getFontFile ()
 Returns the best matching font file with the font weight FontWeight.Normal and the font style FontStyle.Normal. More...
 
- Public Member Functions inherited from Resource
String getName ()
 Gets the resource name. More...
 
String getUrl ()
 Gets the resource URL. More...
 
void setKeepAlive (boolean keepAlive)
 Sets the keep alive flag. More...
 
- Public Member Functions inherited from KanziObject
boolean equals (Object object)
 
Domain getDomain ()
 Returns the domain the object belongs to. More...
 
Metaclass getDynamicMetaclass ()
 Returns the metaclass of the dynamic type of the object. More...
 
long getNative ()
 Gets a pointer to the backing C++ instance. More...
 
TDataType getOptionalProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type, but does not use the default value if there are no inputs to the property value. More...
 
TDataType getProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type. More...
 
int hashCode ()
 
boolean hasValue (PropertyType< TDataType > propertyType)
 Evaluates whether there are any inputs into the property value. More...
 
boolean isStale ()
 Test if the object is stale i.e. More...
 
void removeLocalValue (PropertyType< TDataType > propertyType)
 Removes the local value associated with the property. More...
 
void setProperty (PropertyType< TDataType > propertyType, TDataType value)
 Sets the local value of a property type. More...
 
ObjectRef< TType > tryCreateObjectRef (Class< TType > clazz)
 Tries to create an owning ObjectRef instance to this KanziObject. More...
 

Static Public Member Functions

static ObjectRef< FontFamilycreate (Domain domain, String name)
 Creates a font family resource. More...
 

Static Public Attributes

static final Metaclass metaclass
 The Metaclass for the class. More...
 
- Static Public Attributes inherited from Resource
static final Metaclass metaclass
 The Metaclass for the class. More...
 
- Static Public Attributes inherited from KanziObject
static final Metaclass metaclass = new AbstractMetaclass("Kanzi.Object")
 The Metaclass for the class.
 

Protected Member Functions

 FontFamily (Domain domain, long nativeNode, Metaclass metaclass)
 Wraps a given native font family. More...
 

Additional Inherited Members

- Public Attributes inherited from ResourceMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Resource")
 Metaclass for Resource.
 
- Public Attributes inherited from FontFamilyMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.FontFamily")
 Metaclass for FontFamily.
 

Constructor & Destructor Documentation

FontFamily ( Domain  domain,
long  nativeNode,
Metaclass  metaclass 
)
protected

Wraps a given native font family.

Called by KanziObject#connectObject(long) when connecting to a native node.

Parameters
domainThe UI Domain where this node belongs.
nativeNodeNative object that is backing this node.
metaclassMetaclass data for this node.

Member Function Documentation

void addFontFile ( Font  font,
FontWeight  weight,
FontStyle  style 
)

Adds the passed font for a font family.

Parameters
fontA font file that is added to the font family.
weightWeight for the font file.
styleStyle for the font file.
void addFontFile ( Font  font)

Adds the passed font for a font family.

The font file is set to have the font weight FontWeight.Normal and the font style FontStyle.Normal within this font family.

Parameters
fontA font file that is added to the font family.
static ObjectRef<FontFamily> create ( Domain  domain,
String  name 
)
static

Creates a font family resource.

Parameters
domainThe domain to which you want the font family to belong.
nameThe name of the font family.
Returns
ObjectRef to the created font family.
Font getFontFile ( FontWeight  weight,
FontStyle  style 
)

Returns the best matching font file for the passed arguments weight and style that is held by font family.

If the font family does not contain any font files, returns an empty font file.

Parameters
weightRequested weight.
styleRequested style.
Returns
The best matching font file in the font family. If the font family does not contain any font files, returns an empty font file.
Font getFontFile ( )

Returns the best matching font file with the font weight FontWeight.Normal and the font style FontStyle.Normal.

If the font family does not contain any font files, returns an empty font file.

Returns
The best matching font file in the font family. If the font family does not contain any font files, returns empty font file.

Member Data Documentation

final Metaclass metaclass
static
Initial value:

The Metaclass for the class.